home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat5 / msg.z / msg
Encoding:
Text File  |  2002-10-03  |  9.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. mmmmssssgggg((((5555))))                                                                  mmmmssssgggg((((5555))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      msg - text formatting macros for IRIX messages
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _nnnn_rrrr_oooo_ffff_ffff _----_mmmm_ssss_gggg _f_i_l_e_s
  13.  
  14. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  15.      The _mmmm_ssss_gggg macros are a package of _nnnn_rrrr_oooo_ffff_ffff macro definitions that provides a
  16.      formatting facility for the printed documents of the message system.  The
  17.      Requests subsection defines all available macros.
  18.  
  19.      Virtually all _nnnn_rrrr_oooo_ffff_ffff directives should be unnecessary in conjunction with
  20.      this macro package.  However, they are available if desired and should
  21.      work as documented.  You also can create tables and equations by using
  22.      _tttt_bbbb_llll(1) and _eeee_qqqq_nnnn(1) directives, respectively; these processors work with
  23.      the _mmmm_ssss_gggg macros.
  24.  
  25.    RRRReeeeqqqquuuueeeessssttttssss
  26.      Unless otherwise noted, all _mmmm_ssss_gggg requests (macros) must start at the
  27.      beginning of a line.  No other text lines or words can start with a _....
  28.      symbol.
  29.  
  30.      _...._2222_SSSS         Starts two-column mode.
  31.  
  32.      _...._2222_EEEE         Ends two-column mode.
  33.  
  34.      _...._BBBB_LLLL [_x]     (Bulleted list) Makes an entry in a bulleted list.  The _x is
  35.                  either _dddd for double-spaced list or _ssss for single-spaced list
  36.                  (the default).
  37.  
  38.      _...._CCCC_HHHH _x "_s_t_r_i_n_g_1" "_s_t_r_i_n_g_2"
  39.                  (Column headings) Makes column heads for two-column lists; _x
  40.                  is indent (as in ______TTTT_LLLL); _s_t_r_i_n_g_1 and _s_t_r_i_n_g_2 are column heads.
  41.                  _x cannot be less than 1.28 or greater than 47.  If _x is less
  42.                  than the width of _s_t_r_i_n_g_1, the width of _s_t_r_i_n_g_1 is used as
  43.                  the first column width.  If the first column width would
  44.                  leave the second column less than 5-ens wide, _x is adjusted
  45.                  to keep the second column 5-ens wide.
  46.  
  47.      _...._CCCC_RRRR [_x] [_y] (Counter reset) Resets the counter that is output by the _\\\\_****_nnnn
  48.                  string.  The _x argument is the number at which the next count
  49.                  will start (default is 1).  The _y argument is the type of the
  50.                  counter character (default is Arabic numerals).  For a list
  51.                  of the values that you may use for _y, see the description of
  52.                  the _x argument of the _...._NNNN_LLLL macro).
  53.  
  54.      _...._CCCC_SSSS         (Code start) Begins a block of non-wrapping code lines.  In
  55.                  two-column mode, lines between _...._CCCC_SSSS and _...._CCCC_EEEE macros cannot
  56.                  consist of more than 44 characters.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. mmmmssssgggg((((5555))))                                                                  mmmmssssgggg((((5555))))
  71.  
  72.  
  73.  
  74.      _...._CCCC_EEEE         (Code end) Ends a code block started with _...._CCCC_SSSS.
  75.  
  76.      _...._DDDD_LLLL [_x]     (Dashed list) Makes an entry in a dashed list.  The _x is
  77.                  either _dddd for double-spaced list or _ssss for single-spaced list
  78.                  (the default).
  79.  
  80.      _...._EEEE_QQQQ         Starts equation (with _eeee_qqqq_nnnn); ends equation with _...._EEEE_NNNN.
  81.  
  82.      _...._EEEE_NNNN         Ends equation (with _eeee_qqqq_nnnn).
  83.  
  84.      _...._GGGG_CCCC _""""_g_r_o_u_p" (Group code) Defines the group code to be used for a set of
  85.                  messages.  You must define the group code because it is
  86.                  printed as part of the message identifier for each message.
  87.  
  88.      (Message start) Starts a message block that, by default, will not break
  89.      over columns or pages, unless it is longer than one column (page).  To
  90.      force a message to break over a column or page, use the _bbbb option.  The
  91.      _m_s_g-# is the message number used in the online message system.
  92.  
  93.      _...._MMMM_EEEE  (Message end) Ends a message block.
  94.  
  95.      _...._NNNN_LLLL [_x [_y [_z [_dddd] ] ] ]
  96.           (Numbered list) Makes an entry in a numbered list.  The _x is either
  97.           the type of numerals you want (default is Arabic), or a _dddd to specify
  98.           a double-spaced, Arabic-numbered list.  The _y is the indent between
  99.           the numerals and the paragraph.  The _z is the number at which to
  100.           (re)start the count if you want something other than the first
  101.           character in the series (1 or i or A, and so on).  If you want a
  102.           double-spaced list that uses something other than Arabic numerals
  103.           (so that you cannot specify _dddd for _x), specify the _dddd as a fourth
  104.           argument to _...._NNNN_LLLL.  The _x argument can have one of the following
  105.           values:
  106.  
  107.      Value   Default Indent   Result
  108.      _1111       3.3              Arabic numerals (the default)
  109.      _aaaa       3.3              Lowercase letters
  110.      _AAAA       4                Uppercase letters
  111.      _iiii       4.5              Lowercase roman numerals
  112.      _IIII       5                Uppercase roman numerals
  113.      _dddd       3.3              Arabic numerals, with full blank lines between list entries
  114.  
  115.           You should end numbered lists with the _...._NNNN_NNNN macro.
  116.  
  117.      _...._NNNN_NNNN  (Numbered-list end) Ends numbered list (resets numbers to 1 at that
  118.           level of indent).
  119.  
  120.      _...._PPPP_PPPP [_x]
  121.           (Paragraph (resets indent)) _x is the number of (printed) lines to
  122.           keep together on the same page; the default is 4.  Use this argument
  123.           only if you use the _bbbb option to _...._MMMM_SSSS or if your message is longer
  124.           than one column.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. mmmmssssgggg((((5555))))                                                                  mmmmssssgggg((((5555))))
  137.  
  138.  
  139.  
  140.      _...._SSSS_PPPP [_x]
  141.           Adds vertical space (leading) without resetting indentation.  Use
  142.           ______SSSS_PPPP instead of ______PPPP_PPPP in indented lists and examples).  The _x is the
  143.           number of following lines to keep in one block (not break over
  144.           pages).
  145.  
  146.      _...._SSSS_TTTT "_s_t_r_i_n_g"
  147.           (Section title) _s_t_r_i_n_g is the section title.
  148.  
  149.      _...._TTTT_LLLL [_x [_y] ]
  150.           (Tagged list) Makes a tagged-paragraph list.  The following line is
  151.           the tag, and, on only the first entry, _x is the indent; it cannot be
  152.           less than 1.28 or greater than 47, and if you do not specify it, it
  153.           defaults to 5 ens.  The _y is either _dddd for double-spaced list or _ssss
  154.           for single-spaced list (the default).
  155.  
  156.      _...._TTTT_SSSS  (Table start) Begins a table to be processed with _tttt_bbbb_llll.  Be sure that
  157.           tables are 3.3i or narrower in width.
  158.  
  159.      _...._TTTT_EEEE  (Table end) Ends a table to be processed by _tttt_bbbb_llll.
  160.  
  161.    FFFFoooonnnntttt CCCChhhhaaaannnnggggeeeessss
  162.      _\\\\_ffff_BBBB              Change to bold font (can start anywhere on a line).
  163.  
  164.      _\\\\_ffff_IIII or _\\\\_****_VVVV       Change to italic font (can start anywhere on a line).
  165.  
  166.      _\\\\_ffff_RRRR              Change to roman font (can start anywhere on a line).
  167.  
  168.      _\\\\_****_CCCC              Change to Courier font (can start anywhere on a line).
  169.  
  170.      _\\\\_****_((((_CCCC_bbbb or _\\\\_ffff_((((_CCCC_BBBB   Change to Courier bold font (can start anywhere on a
  171.                       line).
  172.  
  173.      _\\\\_****_((((_CCCC_oooo or _\\\\_ffff_((((_CCCC_OOOO   Change to Courier italic font (can start anywhere on a
  174.                       line).
  175.  
  176.      _\\\\_ffff_PPPP              Change to previous font (use to undo font change).
  177.  
  178.    NNNNoooonnnnpppprrrriiiinnnnttttiiiinnnngggg CCCCoooommmmmmmmeeeennnnttttssss
  179.      _''''_\\\\_""""
  180.  
  181. FFFFIIIILLLLEEEESSSS
  182.      _////_uuuu_ssss_rrrr_////_ssss_hhhh_aaaa_rrrr_eeee_////_llll_iiii_bbbb_////_tttt_mmmm_aaaa_cccc_////_tttt_mmmm_aaaa_cccc_...._ssss_gggg   Message macro package
  183.  
  184. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  185.      eqn(1), explain(1), nroff(1), tbl(1).
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.